@salesforce/source-deploy-retrieve
Advanced tools
JavaScript library to run Salesforce metadata deploys and retrieves
@salesforce/source-deploy-retrieve is an npm package that provides tools for interacting with Salesforce metadata. It allows users to retrieve, deploy, and manage Salesforce source code and metadata from a Salesforce org. This package is particularly useful for developers and administrators who need to automate and streamline their Salesforce development and deployment processes.
Retrieve Metadata
This feature allows you to retrieve metadata from a Salesforce org. The code sample demonstrates how to use the SourceClient to retrieve metadata for a specific package and save it to an output directory.
const { SourceClient } = require('@salesforce/source-deploy-retrieve');
const client = new SourceClient();
client.retrieve({
packageNames: ['MyPackage'],
output: './outputDir'
}).then(result => {
console.log('Retrieve Result:', result);
}).catch(error => {
console.error('Error:', error);
});Deploy Metadata
This feature allows you to deploy metadata to a Salesforce org. The code sample demonstrates how to use the SourceClient to deploy metadata from a specified source directory.
const { SourceClient } = require('@salesforce/source-deploy-retrieve');
const client = new SourceClient();
client.deploy({
sourcePath: './sourceDir'
}).then(result => {
console.log('Deploy Result:', result);
}).catch(error => {
console.error('Error:', error);
});Convert Metadata
This feature allows you to convert metadata between different formats. The code sample demonstrates how to use the SourceClient to convert metadata from a source directory to an output directory.
const { SourceClient } = require('@salesforce/source-deploy-retrieve');
const client = new SourceClient();
client.convert({
sourcePath: './sourceDir',
outputDir: './outputDir'
}).then(result => {
console.log('Convert Result:', result);
}).catch(error => {
console.error('Error:', error);
});The sfdx-cli package is the Salesforce CLI, which provides a powerful set of tools for managing Salesforce orgs, including retrieving and deploying metadata. It offers a broader range of functionalities compared to @salesforce/source-deploy-retrieve, including org management, data manipulation, and more.
The jsforce package is a JavaScript library for Salesforce API integration. It provides tools for interacting with Salesforce data and metadata, including retrieving and deploying metadata. While it offers similar functionalities to @salesforce/source-deploy-retrieve, it also includes capabilities for working with Salesforce data and performing SOQL queries.
The force-dev-tool package is a command-line tool for Salesforce development. It provides functionalities for retrieving, deploying, and managing Salesforce metadata. It is similar to @salesforce/source-deploy-retrieve but is more focused on providing a command-line interface for Salesforce development tasks.
A JavaScript toolkit for working with Salesforce metadata. Built to support the Salesforce CLI deploy and retrieve experience in the Salesforce VS Code Extensions, CLI plugins, and other tools working with metadata.
async/await syntaxPlease report all issues to the issues only repository.
Install the package:
npm install @salesforce/source-deploy-retrieve
See HANDBOOK.md for usage and examples.
See API Docs
See CONTRIBUTING.md for details on how to contribute to the library.
See developing.md for details on building and testing the library locally.
SDR publishes when changes are merged into main. The version is bumped per the rules of the release orb and standard-version.
FAQs
JavaScript library to run Salesforce metadata deploys and retrieves
The npm package @salesforce/source-deploy-retrieve receives a total of 175,041 weekly downloads. As such, @salesforce/source-deploy-retrieve popularity was classified as popular.
We found that @salesforce/source-deploy-retrieve demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.